Skip to main content

PatientUpdate

Description

A Patient Update message is generated when there is a change in patient or registration information while the patient is not currently admitted. This message is used to trigger updates to patient records in various systems, such as changes to demographic information, contact details, insurance information, or other relevant patient data.

API endpoints for Patient Update

Sync REST API Endpoint to call the API: https://{base_url}/api/v1/patient-admin/patient-update.

Async REST API Endpoint to call the API: https://{base_url}/api/v1/endpoint.

Data Model JSON for PatientUpdate​

PatientUpdate - Sample Payload
{
   "Meta": {
      "DataModel": "PatientAdmin",
      "EventType": "PatientUpdate",
      "EventDateTime": "2022-08-16T14:21:20.733Z",
      "Test": true,
      "Source": {
         "ID": "f93ba083-1da9-4d1f-ab0e-49da7cf506e9",
         "Name": "EHR Bridge Dev Tools"
      },
      "Destinations": [
         {
            "ID": "dc175d0e-9b64-45ba-99d2-ba366739c850",
            "Name": "Destinations EMR"
         }
      ],
      "Logs": [
         {
            "ID": "3c9b0146-deb1-407b-86b6-5973286e2840 ",
            "AttemptID": "71a87a14-a334-46ee-9b82-ea0f11c869c5"
         }
      ],
      "Message": {
         "ID": 5565
      },
      "Transmission": {
         "ID": 12414
      },
      "FacilityCode": null
   },
   "Patient": {
      "Identifiers": [
         {
            "ID": "0000000001",
            "IDType": "MR"
         },
         {
            "ID": "685cbb0e-2d28-42c2-bd2e-3e1e1f29e658",
            "IDType": "EHRID"
         },
         {
            "ID": "6c3169b6-3318-47de-ab0c-c04d376b4f94",
            "IDType": "NIST"
         }
      ],
      "Demographics": {
         "FirstName": "Mark",
         "MiddleName": "Calvin",
         "LastName": "Brown",
         "DOB": "2008-01-06",
         "SSN": "101-01-0001",
         "Sex": "Male",
         "Race": "White",
         "IsHispanic": null,
         "Religion": null,
         "MaritalStatus": "Single",
         "IsDeceased": null,
         "DeathDateTime": null,
         "PhoneNumber": {
            "Home": "+18081186301",
            "Office": null,
            "Mobile": null
         },
         "EmailAddresses": [],
         "Language": "en",
         "Citizenship": [],
         "Address": {
            "StreetAddress": "1212 Victorian Street",
            "City": "San Jose",
            "State": "CA",
            "ZIP": "53719",
            "County": "Santa Clara",
            "Country": "USA"
         }
      },
      "Notes": [],
      "Contacts": [
         {
            "FirstName": "Paula",
            "MiddleName": null,
            "LastName": "Brown",
            "Address": {
               "StreetAddress": "4762 High Street",
               "City": "San Jose"",
               "State": "CA",
               "ZIP": "53566",
               "County": "Santa Clara",
               "Country": "USA"
            },
            "PhoneNumber": {
               "Home": "+18088675303",
               "Office": "+17077543758",
               "Mobile": "+19189368865"
            },
            "RelationToPatient": "Mother",
            "EmailAddresses": [
               "paula.Brown@test.net"
            ],
            "Roles": [
               "Emergency Contact"
            ]
         }
      ],
      "Diagnoses": [
         {
            "Code": "R07.0",
            "Codeset": "ICD-10",
            "Name": "Throat Infection",
            "Type": null,
            "DocumentedDateTime": null
         }
      ],
      "Allergies": [
         {
            "Code": "7982",
            "Codeset": "RxNorm",
            "Name": "Penicillin-II",
            "Type": {
               "Code": null,
               "Codeset": null,
               "Name": null
            },
            "OnsetDateTime": null,
            "Reaction": [
               {
                  "Code": "28926001",
                  "Codeset": "SNOMED CT",
                  "Name": "Rashing"
               },
               {
                  "Code": "247472004",
                  "Codeset": "SNOMED CT",
                  "Name": "Hives"
               }
            ],
            "Severity": {
               "Code": null,
               "Codeset": null,
               "Name": null
            },
            "Status": null
         }
      ],
      "PCP": {
         "NPI": "4356789876",
         "ID": "4356789876",
         "IDType": "NPI",
         "FirstName": "Davis ",
         "LastName": "Wilson",
         "Credentials": [
            "MD"
         ],
         "Address": {
            "StreetAddress": "123 High St.",
            "City": "San Jose"",
            "State": "CA",
            "ZIP": "53703",
            "County": "Santa Clara",
            "Country": "USA"
         },
         "EmailAddresses": [],
         "PhoneNumber": {
            "Office": "+16085551234"
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         }
      },
      "Insurances": [
         {
            "Plan": {
               "ID": "31572",
               "IDType": "Payor ID",
               "Name": "HMO Plan",
               "Type": null
            },
            "MemberNumber": null,
            "Company": {
               "ID": "60054",
               "IDType": null,
               "Name": "aetna (60054 0131)",
               "Address": {
                  "StreetAddress": "PO Box 14080",
                  "City": "San Jose"",
                  "State": "CA",
                  "ZIP": "40512-4079",
                  "County": "Santa Clara",
                  "Country": "USA"
               },
               "PhoneNumber": "+18089541123"
            },
            "GroupNumber": "847025-024-0009",
            "GroupName": "Digitech Labs",
            "EffectiveDate": "2015-01-01",
            "ExpirationDate": "2020-12-31",
            "PolicyNumber": "9140860055",
            "Priority": null,
            "AgreementType": null,
            "CoverageType": null,
            "Insured": {
               "Identifiers": [],
               "LastName": null,
               "MiddleName": null,
               "FirstName": null,
               "SSN": null,
               "Relationship": null,
               "DOB": null,
               "Sex": null,
               "Address": {
                  "StreetAddress": null,
                  "City": null,
                  "State": null,
                  "ZIP": null,
                  "County": null,
                  "Country": null
               }
            }
         }
      ],
      "Guarantor": {
         "Number": "10001910",
         "FirstName": "Kent",
         "MiddleName": null,
         "LastName": "Allen",
         "SSN": null,
         "DOB": null,
         "Sex": null,
         "Spouse": {
            "FirstName": "Gracy",
            "LastName": "Allen"
         },
         "Address": {
            "StreetAddress": "4762 Westend Street",
            "City": "San Jose"",
            "State": "CA",
            "ZIP": "53566",
            "County": "Santa Clara",
            "Country": "USA"
         },
         "PhoneNumber": {
            "Home": null,
            "Business": null,
            "Mobile": null
         },
         "EmailAddresses": [],
         "Type": null,
         "RelationToPatient": "Father",
         "Employer": {
            "Name": "Digitech Labs",
            "Address": {
               "StreetAddress": "1456 Old Hill Road",
               "City": "San Jose"",
               "State": "CA",
               "ZIP": "67809",
               "County": "Santa Clara",
               "Country": "USA"
            },
            "PhoneNumber": "+18083451121"
         }
      }
   }
}